home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / comm / term / dshrexx1_0.lha / dshrexx.doc < prev    next >
Text File  |  1993-09-22  |  6KB  |  186 lines
  1.  
  2. DSHREXX - Quick docs:
  3.  
  4.  
  5.  
  6. what does this thing do?
  7. ~~~~~~~~~~~~~~~~~~~~~~~~
  8. it opens a terminal on dnet with a simple arexx & shell interface ie
  9. dshrexx
  10. will run the program with no options and accept input/output from the
  11. shell it was invoked from/in.
  12.  
  13.  
  14.  
  15.  
  16. Why have such a thing?
  17. ~~~~~~~~~~~~~~~~~~~~~~
  18. Shells such as sphinx & wshell have nice history & command entering
  19. facilities so as a shell-term this is quite useful. Also over slow
  20. lines command line editing is a major pain, but not with this, as
  21. normally the shell buffers the lines and so your amiga does all the
  22. editing of lines, command line history etc etc...
  23.  
  24. An arexx script may be started that reads lines (or chars) from a
  25. particular dshrexx term so you can have an auto-talk or whatever.
  26. It would be nice if someone could write some scripts to do stuff
  27. & post them?
  28.  
  29.  
  30. What does it require?
  31. ~~~~~~~~~~~~~~~~~~~~~
  32. Dnet to be installed & running
  33. Amiga computer of some kind
  34. Something to dnet the amiga to (eg
  35.  
  36.  
  37. When running
  38. ~~~~~~~~~~~~
  39. When running CTRL-F will let you enter commands/options
  40. In this version this is a little sloppy but works ok.
  41. eg if you did the following
  42. dshrexx
  43. [It logs you in or connects]
  44. you hit CTRL-F
  45. [dshrexx blah blah]
  46. you type ? <return>
  47. it gives you a list of commands such as
  48. ?       or HELP ((This message))             
  49. R       or RAW ((Raw (normal terminal) mode))
  50. B       or BUF ((Line buffered (shell) mode))
  51. LFCR    ((Linefeed & Carriage Return))       
  52. LF      ((Linefeed))                         
  53. CR      ((Carriage return))                  
  54. SEND    (text)                               
  55. SEND2   (text (without LF/CR))               
  56. F       or FLUSH ((Flush input))
  57. etc
  58. the first UPPERCASE word is the accepted abbreviation, while the second
  59. (if there is one) on the same line is the full command name. Following this
  60. is a lowercase word indicating the argument that should be supplied
  61. and then in ()'s is a short description
  62.  
  63. eg
  64. <CTRL-F> CONSOLE window
  65. means you should enter something like
  66. <CTRL-F> CONSOLE con:0/0/600/100/dnet-shell
  67. or if you have sphinx installed
  68. <CTRL-F> CONSOLE sphinx:0/0/600/100/dnet-shell
  69. or if you have wshell installed
  70. <CTRL-F> CONSOLE cn1:0/0/600/100/dnet-shell
  71.  
  72.  
  73.  
  74. Running the program:
  75. ~~~~~~~~~~~~~~~~~~~~
  76. note that you can
  77. run dshrexx
  78. but to kill it you will have to do a
  79. status
  80. to see which is process it ran as and then
  81. break process_number F
  82. break process_number D
  83. (2 breaks are required in that sequence)
  84.  
  85.  
  86.  
  87.  
  88.  
  89. How to pass arguments
  90. ~~~~~~~~~~~~~~~~~~~~~
  91. the first 3 arguments must be in the following order
  92. dshrexx PORTNUMBER NETWORKNUMBER REXXPORTNAME
  93.  
  94. the PORTNUMBER defaults to 8195 when NONE are specified (note that you can not
  95. specify a NETWORKNUMBER without a PORTNUMBER before it, likewise for REXXPORTNAME)
  96.  
  97. after the intial 3, arguments may appear in any order.
  98. The arguments it accepts are the same as those you type after you press CTRL-F
  99. so yu could for example do this:
  100.  
  101. run dshrexx 8195 0 DNETREXX "console con:0/0/640/100/Yeahh" "send stty -echo\n"
  102. will open the input/output window on con:blah-blah,
  103. send the string "stty -echo" (with a <return>) and then give control to the user.
  104.  
  105. notice that the arguments to the command and the command itself must be
  106. in ""'s. This is how the program seperates the commands.
  107.  
  108. Run the program to get a list of commands
  109.  
  110. note that \n & \r expand to Linefeed & Carriage return respectively so
  111. <returns> can be placed in the command line (or when you hit control F
  112. and enter a command)
  113. also %s & %r both expand to the arexx port name this dshrexx is using
  114. eg
  115. dshrexx
  116. <CTRL-F>x echo %r
  117. will output the name of the arexx port that terminal is using.
  118.  
  119.  
  120.  
  121.  
  122. ARexx Support
  123. ~~~~~~~~~~~~~
  124. At the moment this is a little limited
  125.  
  126. The  port  name is default DNETREXX.01 (actually it is DNETREXX.nn where nn
  127. is  the  next  free  port number, so if you have several dshrexx's with the
  128. same  arexx  port  name  then they will end with nn = 01, nn = 02, nn = 03,
  129. etc). The command line port name is not really honored if specified either.
  130. eg
  131. dshrexx 8195 0 DREXX
  132. then  the  port  actually  opened  will  be  DREXX.01 if there was no other
  133. program  which opened a port called DREXX.01 (otherwise it will be DREXX.02
  134. or DREXX.03 etc or what ever is the first non used number).
  135.  
  136. you should always specify
  137. options results
  138. in your arexx program if you want stuff from dshrexx
  139.  
  140. All of the above commands that can be used in the command line may be sent,
  141. with a result either being what would be normally printed to the screen
  142. (eg in the case of 'LOG ram:xxx' a 'ok: ram:xxx' would be returned if everything
  143. went ok (otherwise an error))
  144. Note that when using send or send2, no linefeed is appended, so when you call
  145. send your string should contain an explicit '0a'x on the end
  146. eg
  147. 'send echo "hello there people"' '0a'x
  148.  
  149. 2 extra commands have been included for arexx which can't be entered otherwise
  150. they are the
  151. GETCHAR & GETLN
  152. they return the next character or line received.
  153. Everything received by the term is buffered for a default of 1K so lines or
  154. characters  will not be lost between getchar's or getln's unless the buffer
  155. is totally filled (then the oldest ones are overwritten).
  156. eg
  157. getln
  158. say 'the line received was' result
  159.  
  160. See the example program on how to use...
  161.  
  162.  
  163.  
  164.  
  165. Bugs:
  166. ~~~~~
  167. o I don't think vi will work with the arrow keys in RAW mode (but hjkl work)
  168.  
  169. o doesn't kick out of raw mode!! (ARRGGG!) can do a CONSOLE to remove
  170.  
  171. o Arexx support is lowly & more or less inefficient
  172.  
  173. o Needs to have extra commands to flush buffer, start buffer etc
  174.  
  175. o Bad docs... (sorry) Dunno how to make something into amigaguide either...
  176.  
  177. o I couldn't bebothered to lharc up the source so no source this time round
  178.  
  179.  
  180. Any comments, please email to
  181. c9107253@mystra.newcastle.edu.au
  182.  
  183. feed back appreciated...
  184.  
  185. - Darrell
  186.